Super-fy the zed command doc #5460
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
philrz
commented
Nov 10, 2024
Comment on lines
+34
to
+37
| A SuperDB data lake is a cloud-native arrangement of data, optimized for search, | ||
| analytics, ETL, data discovery, and data preparation | ||
| at scale based on data represented in accordance | ||
| with the [Zed data model](../formats/zed.md). | ||
| with the [super data model](../formats/zed.md). |
There was a problem hiding this comment.
Like in #5457, I know this top-level "what is it" summary needs to change, but I have difficulty coming up with the right wording. Happy to take suggestions or have someone else take a crack in a follow-up PR.
Comment on lines
+187
to
+188
| - `%LOCALAPPDATA%\super` on Windows | ||
| - `$HOME/.local/share/super` on Linux and macOS |
There was a problem hiding this comment.
These are aspirational paths in anticipation of a future change in the code.
| lake can be easily queried. | ||
|
|
||
| If a writer commits data after and while a reader is scanning, then the reader | ||
| If a writer commits data after or while a reader is scanning, then the reader |
There was a problem hiding this comment.
Wanted to call extra attention to this change. The and didn't read right. But if I'm missing something, please correct me.
Comment on lines
+662
to
+664
| The `query` command runs a [SuperSQL](../language/README.md) query with data from a lake as input. | ||
| A query typically begins with a [`from` operator](../language/operators/from.md) | ||
| indicating the pool and branch to use as input. |
There was a problem hiding this comment.
Amputated some text here because of the changes in #5418.
mccanne
approved these changes
Nov 11, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
If reviewers would like to just read the content in rendered form, I've published it to a personal staging site. The primary updated article is at https://spiffy-gnome-8f2834.netlify.app/docs/next/commands/super-db.